home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / info-service / gopher / Unix / GopherTools / tstb / README next >
Encoding:
Text File  |  1992-10-14  |  3.4 KB  |  100 lines
  1. Documentation for ts/tb                Dennis Boone (boone@convex.cl.msu.edu)
  2. =============================================================================
  3. The ts/tb package consists of several simple programs which allow you to
  4. create and search a keyword index of the user-visible titles in your
  5. Gopher server.
  6.  
  7. The programs are:
  8. -----------------
  9.     tb       Creates the index file
  10.     ts       Executes a search using either tsc or tsp
  11.     tsc      The C version of the search engine
  12.     tsp      The Perl version of the search engine (descendant of
  13.              the old ts
  14.  
  15. The data file created by .tb is called .ts/.tsdata
  16.  
  17. The package depends on Perl and gopherls.  Gopherls is a feature of the
  18. Gopher server which is not available in earlier versions.  Perl is a
  19. feature of Larry Wall's nightmares.
  20.  
  21. -----------------------------------------------------------------------------
  22. History of Revisions:
  23. -----------------------------------------------------------------------------
  24. Version        Changes
  25. -------        -------------------------------------
  26. 1.0        Initial release
  27. 1.1        ts (original Perl version) rewritten to only search 
  28.         the user-visible name field.  Since this rewrite 
  29.         caused a performance problem, the tsc module was written.
  30. 1.2        Bugfix to a problem which prevented ts/tb from working in
  31.         a subdirectory.
  32. -----------------------------------------------------------------------------
  33. Installation Instructions for ts/tb:
  34. -----------------------------------------------------------------------------
  35. Unpack this stuff into a working directory.  (You already did that, yes?)
  36.  
  37. Decide which version of the search engine you will use.  Some crude measures
  38. of performance:
  39.  
  40.     program        words    seconds
  41.     -------        -----     -------
  42.     old ts        1    2
  43.     old ts        3    6
  44.     tsp        1    10
  45.     tsp        3    12
  46.     tsc        1    .7
  47.     tsc        3    1.7
  48.  
  49.     All numbers generated on my RS/6000-520 using the timex command.
  50.     The data file used for these timings contained ~5600 lines, and
  51.     ~427000 bytes.
  52.  
  53. If you're going to use the tsc module, build it.
  54.  
  55. If you're going to use tsp, edit ts and change the second line to say
  56. tsp instead of tsc.
  57.  
  58. Look at tb, in the comments near the top, to learn all about the possible
  59. problems you could have with gopherls.  Take care of those issues now.
  60.  
  61. Set up the directory structure.  Here we'll assume that your Gopher lives
  62. in a directory called /home/gopherdata.  Make the appropriate substitutions
  63. if that is not true, or if you want to index a subtree instead of the
  64. whole thing.
  65.  
  66.     /home/gopherdata/
  67.         ts            The interface script
  68.         .ts/            The invisible hidey hole for .tsdata
  69.             tsc        Only one of these two is needed, but
  70.             tsp        both won't hurt anything...
  71.             tb        The index builder
  72.  
  73. Build the first index by hand:
  74.  
  75.     cd /home/gopherdata; /home/gopherdata/.ts/tb
  76.  
  77. Make a crontab entry to run tb periodically.  In this example, it runs
  78. every night at 2 am.
  79.  
  80.     0 2 * * * cd /home/gopherdata; /home/gopherdata/.ts/tb
  81.  
  82. Make /home/gopherdata/.cap/ts (a side file):
  83.  
  84.     Type=7
  85.     Name=Search Gopher Tree
  86.  
  87. Make sure that all of the scripts and programs have their execute bit set.
  88. Gopher won't run them if they don't.
  89.  
  90. Test it.
  91.  
  92. -----------------------------------------------------------------------------
  93.  
  94. If you want to index your whole tree, but want the index to hide in a
  95. subdirectory, use the following commands:
  96.  
  97.     cd /home/gopherdata/index; .ts/tb /home/gopherdata
  98.  
  99. -----------------------------------------------------------------------------
  100.